/**
 * @apiDefine userInfo
 * @apiSuccess {String} data.userName 用户名
 * @apiSuccess {Boolean} data.isAdmin 是否是管理员
 * @apiSuccess {Number} data.phone 手机号
 */

// 正常的get请求
/**
 * @apiVersion 1.0.0
 * @api {get} /user/list 用户列表
 * @apiName list
 * @apiGroup user
 * @apiDescription 用户列表api
 * 根据用户类型，用户名可以查询列表
 * 
 * 但是查询必须携带登录的token才行
 * 
 * @apiPermission admin
 * 
 * @apiHeader {String} ulives-token 用户登录成功的token凭证
 * 
 * @apiParam {String="1-管理员","0-普通用户"} type=0 用户类型
 * @apiParam {String} [userName] 用户名
 * 
 * @apiUse ResFormat
 * @apiSuccess {aUser[]} data 列表数据
 * @apiSuccess {String} data.userName 用户名
 * @apiSuccess {Boolean} data.isAdmin 是否是管理员
 * @apiSuccess {Number} data.phone 手机号
 * 
 * @apiSuccess (aUser) {String} userName 用户名
 * @apiSuccess (aUser) {Boolean} isAdmin 是否是管理员
 * @apiSuccess (aUser) {Number} phone 手机号
 * 
 * @apiSampleRequest off
 */

/**
 * @apiVersion 1.0.0
 * @api {post} /user/login 用户登录
 * @apiName login
 * @apiGroup user
 * @apiDescription 用户登录
 * @apiPermission none
 * 
 * @apiParam {String} type 类型
 * 
 * @apiBody {String} userName 用户名
 * @apiBody {String} password 密码
 * 
 * @apiSuccess {Boolean} success true-成功;false-失败
 * @apiSuccess {String} msg 错误提示
 * @apiSuccess {Object} data 返回的用户信息
 * @apiSuccess {String} data.userName 用户名
 * @apiSuccess {Boolean} data.isAdmin 是否是管理员
 * @apiSuccess {Number} data.phone 手机号
 * 
 * @apiSampleRequest http://api.com
 */

/**
 * @apiVersion 1.0.0
 * @api {post} /user/save 用户注册
 * @apiName save
 * @apiGroup user
 * @apiDescription 此api用于用户注册
 * @apiPermission none
 * 
 * @apiParam {String} username 用户名
 * @apiParam {String} password 密码
 * @apiParam {String} phone 手机号
 * @apiParam {String} email 邮箱
 * 
 * @apiSuccess {Boolean} success true-成功;false-失败
 * @apiSuccess {String} msg 错误提示
 * @apiSuccess {Object} data 返回的用户信息
 * @apiUse userInfo
 * 
 * @apiSampleRequest /pre-login
 */

/**
 * @apiIgnore 不在文档中生成
 * @apiVersion 1.0.0
 * @api {get} /user/delete 用户删除
 * @apiName delete
 * @apiGroup user
 * @apiDescription 用户删除 只允许后台删除-不开放
 * 
 * @apiParam {String} userId 用户Id
 * 
 * @apiSuccess {Boolean} success true-成功;false-失败
 * @apiSuccess {String} msg 错误提示
 * 
 * @apiSampleRequest http://api.com/api/user
 */
